Xceed .NET Libraries Documentation
Xceed.Zip Assembly / Xceed.Zip Namespace / QuickZip Class / Zip Method / Zip(String,String,EncryptionMethod,CompressionMethod,Boolean,Boolean,Boolean,String[]) Method
The fully-qualified path and name of the zip file.
The password that will be used to encrypt the files.
The EncryptionMethod used to encrypt the files. If EncryptionMethod.WinZipAes is passed, an encryption strength of 256 will be used.
The CompressionMethod used to compress the file.
Boolean value indicating if existing files should be overwritten.
Boolean value indicating if files contained within sub-folders should be added to the zip file.
Boolean value indicating if the directory structure should be preserved in the zip file.
The files to add to zipFileName. Can contain filemasks and folder names (ending with a backslash). All subfolders will also be scanned for the specified file(s), even if wildcards are not used, if recursive is set to true. For example, if "C:\test.txt" is specified, all "test.txt" files found on the "C:\" drive will be added to the zip file. Folders specified with the backslash after them will include their entire contents. Cannot be a null reference (Nothing in Visual Basic).


In This Topic
    Zip(String,String,EncryptionMethod,CompressionMethod,Boolean,Boolean,Boolean,String[]) Method
    In This Topic
    Adds files to a zip file using an encryption password and specifying an encryption mehtod, whether existing files will be overwritten and if the directory structure will be preserved.
    Syntax
    'Declaration
     
    Public Overloads Shared Sub Zip( _
       ByVal zipFileName As String, _
       ByVal encryptionPassword As String, _
       ByVal encryptionMethod As EncryptionMethod, _
       ByVal compressionMethod As CompressionMethod, _
       ByVal replaceExistingFiles As Boolean, _
       ByVal recursive As Boolean, _
       ByVal preservePaths As Boolean, _
       ByVal ParamArray filesToZip() As String _
    ) 
    'Usage
     
    Dim zipFileName As String
    Dim encryptionPassword As String
    Dim encryptionMethod As EncryptionMethod
    Dim compressionMethod As CompressionMethod
    Dim replaceExistingFiles As Boolean
    Dim recursive As Boolean
    Dim preservePaths As Boolean
    Dim filesToZip() As String
     
    QuickZip.Zip(zipFileName, encryptionPassword, encryptionMethod, compressionMethod, replaceExistingFiles, recursive, preservePaths, filesToZip)

    Parameters

    zipFileName
    The fully-qualified path and name of the zip file.
    encryptionPassword
    The password that will be used to encrypt the files.
    encryptionMethod
    The EncryptionMethod used to encrypt the files. If EncryptionMethod.WinZipAes is passed, an encryption strength of 256 will be used.
    compressionMethod
    The CompressionMethod used to compress the file.
    replaceExistingFiles
    Boolean value indicating if existing files should be overwritten.
    recursive
    Boolean value indicating if files contained within sub-folders should be added to the zip file.
    preservePaths
    Boolean value indicating if the directory structure should be preserved in the zip file.
    filesToZip
    The files to add to zipFileName. Can contain filemasks and folder names (ending with a backslash). All subfolders will also be scanned for the specified file(s), even if wildcards are not used, if recursive is set to true. For example, if "C:\test.txt" is specified, all "test.txt" files found on the "C:\" drive will be added to the zip file. Folders specified with the backslash after them will include their entire contents. Cannot be a null reference (Nothing in Visual Basic).
    Remarks

    The PPMd algorithm uses a custom memory management system called SubAllocator. In a zip file, the memory size the SubAllocator uses is defined in the WinZip PPMd header for the compressed file and this header's value is used when decompressing the data. In general, WinZip uses 64Mb. Since the algorithm used was not optimized from the original PPMd version I revision 1, the SubAllocator initially requires the total amount of memory specified in the PPMd compressor. This means you must have at least 64 free Mb of RAM when using this compression method.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also